Skip to content

Add VitePress to the Repository #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add VitePress to the Repository #19

wants to merge 6 commits into from

Conversation

Mateleo
Copy link

@Mateleo Mateleo commented Mar 9, 2025 •
edited
Loading

This PR introduces VitePress as the documentation tool for the repository. I believe it's a good choice for its simplicity, speed, and Markdown-first approach, which aligns perfectly with our needs for documenting the Generals & Zero Hour community project.

What's Changed

  • Added VitePress configuration and setup.
  • Created a basic homepage.
  • Marmaid support as requested by @tintinhamans
  • No conflicts with main !

Things you need to know

the _Footer and _Navbar files are not used, I hardcoded the contents of these files myself. Everything can be modified in .vitepress/config.mts.

How to Test

You will need pnpm

  1. Install dependencies: pnpm i
  2. run the project: npm run dev

image

@Mateleo Mateleo changed the title vitepress init Add VitePress to the Repository Mar 9, 2025
@Mateleo
Copy link
Author

Mateleo commented Mar 9, 2025

image

@Mateleo
Copy link
Author

Mateleo commented Mar 9, 2025

image

@tintinhamans tintinhamans added the enhancement New feature or request label Mar 9, 2025
@tintinhamans tintinhamans mentioned this pull request Mar 16, 2025
Open
@roossienb
Copy link
Contributor

How does this compare to what we have now? Is it a theme that changes the layout? Does it work out of the box on github once we merge it?

@Mateleo
Copy link
Author

Mateleo commented Jul 22, 2025

@roossienb Sorry I'm a bit out of the loop rn. Vitepress is a way to create beautiful documentation sites with markdown files. It's just a super-quick and pretty way to have a wiki website.

@roossienb
Copy link
Contributor

@roossienb Sorry I'm a bit out of the loop rn. Vitepress is a way to create beautiful documentation sites with markdown files. It's just a super-quick and pretty way to have a wiki website.

Is it something you would be willing to put time in and maintain?

@Mateleo
Copy link
Author

Mateleo commented Jul 23, 2025

@roossienb Yes it was my goal. But first I need to be sure of the objectives and the need. You want a site to display the documentation? Something extra/special?

@roossienb
Copy link
Contributor

roossienb commented Jul 24, 2025 •
edited
Loading

At this point not super clear where the wiki is heading.
For one, they are two wiki's (one for generalsgamecode and one for generalsgamepatch ( = assets)

The generalsgamecode consists of information about

  • compiling the application yourself
  • contributing to the development process (e.g. testing)
  • documentation of the application (like debug hotkeys or -- soon to be added - command line arguments and new ini options)

In the future, it may as well contain more user facing information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Mateleo @roossienb @tintinhamans